/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.spring.multipart;

import java.util.regex.Pattern;

/**
 * file upload listener to generate progress bar.
 */
public interface RequestUploadListener
{

  /**
   * returns a regular expression describing the uploads that this listener must
   * register with. This is compared to the pathInfo of the requests.
   * 
   * @return a regular expression describing the uploads that this listener must
   *         register with
   */
  public abstract Pattern getBindingPath();



  /**
   * Updates the listeners status information.
   * 
   * @param pBytesRead
   *          The total number of bytes, which have been read so far.
   * @param pContentLength
   *          The total number of bytes, which are being read. May be -1, if
   *          this number is unknown.
   */
  void update(long pBytesRead, long pContentLength);

}
